HR - Employees - REST API

This operation allows to send additionnal Employee data like Handicap(s), Graduation(s), Skill(s) ... to the HR Datahub (CIM)

REQUEST

url: /rest/v1/hr/employeeDetails

body: JSON format, containing all fields as below

Here is the format of the body that you should send:

⚠️ Note: Before using the ADDON FIELD segment, please contact the Integration team. ⚠️

{
  "HEADER":{
    "CORRELATION_ID": {Technical unique identifier for each message},
    "EMPLOYEE_ERP_ID": {Personal number},
    "ERP_SOURCE": {Name of ERP Source_ISO code of the country},
    "COMPANY_CODE": {ROC Company ANALYTICAL code},
    "OSMOSE_CODE": {ROC Company OSMOSE code},
    "ANALYTICAL_CODE": {ROC BU code},
    "REQUEST_DATE_TIME": {WS Request DateTime},
    "SOURCE_SYSTEM": {Identifies the CALLER SYSTEM},
    "TARGET_SYSTEM": {Fixed value "DALI"},
    "TRANSACTION_ID": {Functional Identifier},
    "FLOW_NAME": {Fixed value "EMPLOYEE_DETAILS"}
  },
  "PAYLOAD":{
    "GRADUATION":[{
      "GRADUATION_ID": {Graduation identifier},
      "SCHOOL_ID": {Identifier of the school where the graduation was obtained},
      "LEVEL": {Graduation level},
      "SPECIALIZATION": {Graduation specialization},
      "SUB_SPECIALIZATION": {Graduation sub-specialization},
      "START_DATE": {Start date of study of the graduation concerned},
      "END_DATE": {End date of study of the graduation concerned},
      "GRADUATION_DATE": {Date on which the graduation was obtained},
      "COMMENTS": {Comments},
      "UPDATE_DATE": {Last update of the graduation format 'YYYY-MM-DD hh:mm:ss'}
    }],
    "SKILL":[{
      "SKILL_ID": {Skill identifier},
      "TYPE": {Skill type},,
      "SUB_TYPE": {Skill sub-type},
      "LEVEL": {Skill level},
      "START_DATE": {Start date of study of the skill concerned},
      "END_DATE": {End date of study of the skill concerned},
      "EFFECTIVE_DATE": {Date on which the skill was obtained},
      "COMMENTS": {Comments},
      "UPDATE_DATE": {Last update of the skill format 'YYYY-MM-DD hh:mm:ss'}
    }],
    "HANDICAP":[{
      "HANDICAP_ID": {Handicap identifier},
      "START_DATE": {Start date of study of the handicap concerned},
      "END_DATE": {End date of study of the handicap concerned},
      "EFFECTIVE_DATE": {Date on which the handicap was effective},
      "UPDATE_DATE": {Last update of the handicap format 'YYYY-MM-DD hh:mm:ss'}
    }],
    "ADDON_FIELD":[{
      "FIELD_TYPE": {Addon field Type},
      "FIELD_SUBTYPE": {Addon field Sub-type},
      "FIELD_NAME": {Addon field name},
      "FIELD_VALUE": {Addon field value},
      "START_DATE": {Start date of study of the addon field concerned},
      "END_DATE": {End date of study of the addon field concerned},
      "EFFECTIVE_DATE": {Date on which the addon field was active},
      "UPDATE_DATE": {Last update of the addon field format 'YYYY-MM-DD hh:mm:ss'}
    }]
  }
}

RESPONSE

Here is the format of the response we send:

{
  "ERROR": {
    "CODE": {error code},
    "DESCRIPTION": {error description},
    "DETAILS": {error details}
  }
}

Here are the different errors that we can send:

MAPPING

Here are further informations on each field:

APPENDIX EMPLOYEE_DETAILS

START DATE

This field must be initialized, as a YYYY-MM-DD format, in order to identify all changes of occurrences regarding the employee management.

E.g. : graduation, skill, handicap, addon field...

END DATE

This field must be initialized, as a YYYY-MM-DD format.

If there is no END_DATE defined for an employee, the date must be filled with 2999-12-31 value.

EXAMPLES

Adding graduations data to an employee

{
  "HEADER": {
    "CORRELATION_ID": "9ee0c962-3014-4643-9ade-3d9639686a76",
    "EMPLOYEE_ERP_ID": "123459",
    "SOURCE_SYSTEM": "SAP_DE",
    "ERP_SOURCE": "SAP_DE",
    "COMPANY_CODE": "D080",
    "OSMOSE_CODE": "10421",
    "ANALYTICAL_CODE": "12460",
    "REQUEST_DATE_TIME": "2025-01-15T22:24:18.257",
    "TARGET_SYSTEM": "DALI",
    "TRANSACTION_ID": "1528-8957-4587-5232",
    "FLOW_NAME": "EMPLOYEE_DETAILS"
  },
  "PAYLOAD": {
    "GRADUATION": [
      {
        "GRADUATION_ID": "2115",
        "SCHOOL_ID": "01",
        "LEVEL": "BAC +5",
        "SPECIALIZATION": "INFORMATIQUE",
        "SUB_SPECIALIZATION": "IA",
        "START_DATE": "2019-09-01",
        "END_DATE": "2024-08-30",
        "GRADUATION_DATE": "2024-08-31",
        "COMMENTS": "Mention très bien.",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      },
      {
        "GRADUATION_ID": "2116",
        "SCHOOL_ID": "02",
        "LEVEL": "N/A",
        "SPECIALIZATION": "Professeur des écoles",
        "SUB_SPECIALIZATION": "",
        "START_DATE": "2019-09-01",
        "END_DATE": "2024-08-30",
        "GRADUATION_DATE": "2024-08-31",
        "COMMENTS": "CAPES",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      }
    ],
    "SKILL": [],
    "HANDICAP": [],
    "ADDON_FIELD": []
  }
}

Adding handicap data to an employee

{
  "HEADER": {
    "CORRELATION_ID": "9ee0c962-3014-4643-9ade-3d9639686a76",
    "EMPLOYEE_ERP_ID": "123459",
    "SOURCE_SYSTEM": "SAP_DE",
    "ERP_SOURCE": "SAP_DE",
    "COMPANY_CODE": "D080",
    "OSMOSE_CODE": "10421",
    "ANALYTICAL_CODE": "12460",
    "REQUEST_DATE_TIME": "2025-01-15T22:24:18.257",
    "TARGET_SYSTEM": "DALI",
    "TRANSACTION_ID": "1528-8957-4587-5232",
    "FLOW_NAME": "EMPLOYEE_DETAILS"
  },
  "PAYLOAD": {
    "GRADUATION": [],
    "SKILL": [],
    "HANDICAP": [
      {
        "HANDICAP_ID": "1",
        "START_DATE": "2017-01-01",
        "END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2017-01-01",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      }
    ],
    "ADDON_FIELD": []
  }
}

Adding skills data to an employee

{
  "HEADER": {
    "CORRELATION_ID": "9ee0c962-3014-4643-9ade-3d9639686a76",
    "EMPLOYEE_ERP_ID": "123459",
    "SOURCE_SYSTEM": "SAP_DE",
    "ERP_SOURCE": "SAP_DE",
    "COMPANY_CODE": "D080",
    "OSMOSE_CODE": "10421",
    "ANALYTICAL_CODE": "12460",
    "REQUEST_DATE_TIME": "2025-01-15T22:24:18.257",
    "TARGET_SYSTEM": "DALI",
    "TRANSACTION_ID": "1528-8957-4587-5232",
    "FLOW_NAME": "EMPLOYEE_DETAILS"
  },
  "PAYLOAD": {
    "GRADUATION": [],
    "SKILL": [
      {
        "SKILL_ID": "12",
        "TYPE": "01",
        "LEVEL": "DAN2",
        "START_DATE": "2010-01-01",
        "END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2010-01-01",
        "COMMENTS": "Bonne maitrise",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      },
      {
        "SKILL_ID": "185",
        "TYPE": "03",
        "LEVEL": "C2",
        "START_DATE": "2020-01-01",
        "END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2020-01-01",
        "COMMENTS": "",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      }
    ],
    "HANDICAP": [],
    "ADDON_FIELD": []
  }
}

Adding graduations/ skills / handicaps data to an employee

{
  "HEADER": {
    "CORRELATION_ID": "9ee0c962-3014-4643-9ade-3d9639686a76",
    "EMPLOYEE_ERP_ID": "123459",
    "SOURCE_SYSTEM": "SAP_DE",
    "ERP_SOURCE": "SAP_DE",
    "COMPANY_CODE": "D080",
    "OSMOSE_CODE": "10421",
    "ANALYTICAL_CODE": "12460",
    "REQUEST_DATE_TIME": "2025-01-15T22:24:18.257",
    "TARGET_SYSTEM": "DALI",
    "TRANSACTION_ID": "1528-8957-4587-5232",
    "FLOW_NAME": "EMPLOYEE_DETAILS"
  },
  "PAYLOAD": {
    "GRADUATION": [
      {
        "GRADUATION_ID": "2115",
        "SCHOOL_ID": "01",
        "LEVEL": "BAC +5",
        "SPECIALIZATION": "IA",
        "START_DATE": "2019-09-01",
        "END_DATE": "2024-08-30",
        "GRADUATION_DATE": "2024-08-31",
        "COMMENTS": "Mention très bien.",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      },
      {
        "GRADUATION_ID": "2116",
        "SCHOOL_ID": "02",
        "LEVEL": "N/A",
        "SPECIALIZATION": "Professeur des écoles",
        "START_DATE": "2019-09-01",
        "END_DATE": "2024-08-30",
        "GRADUATION_DATE": "2024-08-31",
        "COMMENTS": "CAPES",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      }
    ],
    "SKILL": [
      {
        "SKILL_ID": "12",
        "TYPE": "01",
        "LEVEL": "DAN2",
        "START_DATE": "2010-01-01",
        "END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2010-01-01",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      },
      {
        "SKILL_ID": "185",
        "TYPE": "03",
        "LEVEL": "C2",
        "START_DATE": "2020-01-01",
        "END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2020-01-01",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      }
    ],
    "HANDICAP": [
      {
        "HANDICAP_ID": "1",
        "START_DATE": "2017-01-01",
        "END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2017-01-01",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      },
      {
        "HANDICAP_ID": "2",
        "START_DATE": "2012-01-01",
        "END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2012-01-01",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      }
    ],
    "ADDON_FIELD": []
  }
}

Adding addon field data to an employee

{
  "HEADER": {
    "CORRELATION_ID": "9ee0c962-3014-4643-9ade-3d9639686a76",
    "EMPLOYEE_ERP_ID": "123459",
    "SOURCE_SYSTEM": "SAP_DE",
    "ERP_SOURCE": "SAP_DE",
    "COMPANY_CODE": "D080",
    "OSMOSE_CODE": "10421",
    "ANALYTICAL_CODE": "12460",
    "REQUEST_DATE_TIME": "2025-01-15T22:24:18.257",
    "TARGET_SYSTEM": "DALI",
    "TRANSACTION_ID": "1528-8957-4587-5232",
    "FLOW_NAME": "EMPLOYEE_DETAILS"
  },
  "PAYLOAD": {
    "GRADUATION": [],
    "SKILL": [],
    "HANDICAP": [],
    "ADDON_FIELD": [
      {
        "FIELD_TYPE": "PERSONAL",
        "FIELD_SUBTYPE": "ADDRESS",
        "FIELD_NAME": "POSTAL_CODE",
        "FIELD_VALUE": "72230",
        "START_DATE": "2025-01-15",
        “END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2025-01-15",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      },
      {
        "FIELD_TYPE": "PERSONAL",
        "FIELD_SUBTYPE": "PHONE",
        "FIELD_NAME": "MOBILE_PHONE",
        "FIELD_VALUE": "+33 658748962",
        "START_DATE": "2025-01-15",
        “END_DATE": "2999-12-31",
        "EFFECTIVE_DATE": "2025-01-15",
        "UPDATE_DATE": "2025-01-15 22:24:18"
      }
    ]
  }
}